/* 
 * Gneat (http://gneat.org)
 *
 * (C) Copyright 2011 and beyond - Claudio Stella, all rights reserved.
 *
 * This file is part of Gneat.
 *
 * Gneat is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License (LGPL)
 * as published by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Gneat is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * and the GNU General Public License, for completeness, along with Gneat.  
 * If not, see <http://www.gnu.org/licenses/>.
 */
package org.neatshell.gneat.client.presenter.core.manipulation;

import org.neatshell.gneat.client.presenter.core.IPresenter;
import org.neatshell.gneat.client.presenter.core.manipulation.css.Css;

public interface StyleProperties {	
	/**
	 * Get the value of a css property, if set on this Presenter's underlying ELEMENT.
	 * @param prop a {@link Css} object mapping a css property.
	 * @return the value of the property if set, null otherwise.
	 */
	String css(Css prop);
	
	/**
	 * Get the value of a css property, if set on this Presenter's underlying ELEMENT.
	 * @param propName a valid css property name.
	 */
	String css(String propName);

	/**
	 * Set a value for a css property, on this Presenter's underlying ELEMENT.
	 * @param prop the css property to set
	 * @param value the value to set
	 */
	IPresenter css(Css prop, String value);
	IPresenter css(String propName, String propValue);

	/**
	 * Shorthand method for css(Css.HEIGHT, value).
	 * @param value an integer with a unit of measure provided
	 */
	IPresenter height(String value);

	/**
	 * Shorthand method for css(Css.DISPLAY, "none").
	 * Hide this Presenter's underlying ELEMENT.
	 */
	IPresenter hide();
	
	/**
	 * Remove the display=none css property if was previously set,
	 * showing this Presenter's underlying ELEMENT.
	 */
	IPresenter show();
	
	/**
	 * Toggle the display=none css property on this Presenter's 
	 * underlying ELEMENT.
	 */
	IPresenter toggle();
	
	/**
	 * Shorthand for css(Css.WIDTH, value).
	 * @param value an integer with a unit of measure provided
	 */
	IPresenter width(String value);
}
